﻿/******************************************************************************
 *  Project:		Neddle Community Edition
 *  Filename:		DecimalExtensions.cs
 *	Created By:     Kristopher Cargile <kristopher@neddle.org>
 *  Date Created:	March 29, 2011
 * ****************************************************************************
 * IMPORTANT GNU LICENSE INFORMATION. DO NOT REMOVE THIS SECTION!
 * 
 * Neddle :: Copyright (c) 2010-2012, Cargile Technology Group, LLC
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 ******************************************************************************/

namespace Neddle 
{
    /// <summary>
    /// Extensions for decimals
    /// </summary>
    public static class DecimalExtensions
    {
        /// <summary>
        /// Calculates the scale required to show the significant digits
        /// </summary>
        /// <param name="parm"></param>
        /// <returns></returns>
        public static int CalculateScale(this decimal parm)
        {
            string s = parm.ToString("G29");
            int dotIndex = s.IndexOf('.');
            int scale = 0;
            if (dotIndex >= 0)
            {
                scale = s.Length - (dotIndex + 1);
            }
            return scale;
        }

        /// <summary>
        /// Calculates the scale required to show the significant digits
        /// </summary>
        /// <param name="parm"></param>
        /// <returns></returns>
        public static int CalculateScale(this decimal? parm)
        {
            int scale = 0;
            if (parm.HasValue)
            {
                scale = parm.Value.CalculateScale();
            }
            return scale;
        }

        /// <summary>
        /// Central function for decimal ToString formatting
        /// </summary>
        /// <param name="parm">decmal? to format</param>
        /// <returns>formatted decimal string</returns>
        public static string ToFormattedString(this decimal? parm)
        {
            string val = "0";
            if (parm.HasValue)
            {
                val = parm.Value.ToFormattedString();
            }
            return val;
        }

        /// <summary>
        /// Central function for decimal ToString formatting
        /// </summary>
        /// <param name="parm">decmal to format</param>
        /// <returns>formatted decimal string</returns>
        public static string ToFormattedString(this decimal parm)
        {
            return parm.ToString("G29");
        }
    }
}
